<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span><a name="line.1"></a>
<span class="sourceLineNo">002</span>/*<a name="line.2"></a>
<span class="sourceLineNo">003</span> * Copyright (C) 2011 Archie L. Cobbs. All rights reserved.<a name="line.3"></a>
<span class="sourceLineNo">004</span> *<a name="line.4"></a>
<span class="sourceLineNo">005</span> * $Id: PropertyDef.html 740 2013-10-02 21:27:31Z archie.cobbs $<a name="line.5"></a>
<span class="sourceLineNo">006</span> */<a name="line.6"></a>
<span class="sourceLineNo">007</span><a name="line.7"></a>
<span class="sourceLineNo">008</span>package org.dellroad.stuff.vaadin7;<a name="line.8"></a>
<span class="sourceLineNo">009</span><a name="line.9"></a>
<span class="sourceLineNo">010</span>import com.vaadin.data.Container;<a name="line.10"></a>
<span class="sourceLineNo">011</span>import com.vaadin.data.Item;<a name="line.11"></a>
<span class="sourceLineNo">012</span>import com.vaadin.data.Property;<a name="line.12"></a>
<span class="sourceLineNo">013</span>import com.vaadin.data.util.ObjectProperty;<a name="line.13"></a>
<span class="sourceLineNo">014</span>import com.vaadin.ui.Table;<a name="line.14"></a>
<span class="sourceLineNo">015</span><a name="line.15"></a>
<span class="sourceLineNo">016</span>import java.util.Comparator;<a name="line.16"></a>
<span class="sourceLineNo">017</span><a name="line.17"></a>
<span class="sourceLineNo">018</span>/**<a name="line.18"></a>
<span class="sourceLineNo">019</span> * Defines a Vaadin property, having a name, which is also the property ID, and its type.<a name="line.19"></a>
<span class="sourceLineNo">020</span> * This class provides a mechanism for the explicit naming and identification of Vaadin properties.<a name="line.20"></a>
<span class="sourceLineNo">021</span> *<a name="line.21"></a>
<span class="sourceLineNo">022</span> * &lt;p&gt;<a name="line.22"></a>
<span class="sourceLineNo">023</span> * For a given instance, &lt;code&gt;def.{@link #getPropertyId getPropertyId()}&lt;/code&gt; is the property ID<a name="line.23"></a>
<span class="sourceLineNo">024</span> * and you can access the value using &lt;code&gt;def.{@link #read read(item)}&lt;/code&gt;.<a name="line.24"></a>
<span class="sourceLineNo">025</span> *<a name="line.25"></a>
<span class="sourceLineNo">026</span> * &lt;p&gt;<a name="line.26"></a>
<span class="sourceLineNo">027</span> * Example:<a name="line.27"></a>
<span class="sourceLineNo">028</span> * &lt;blockquote&gt;&lt;pre&gt;<a name="line.28"></a>
<span class="sourceLineNo">029</span> *  PropertyDef&amp;lt;Integer&amp;gt; def = new PropertyDef&amp;lt;Integer&amp;gt;("age", Integer.class, -1);<a name="line.29"></a>
<span class="sourceLineNo">030</span> *  def.addTo(container);<a name="line.30"></a>
<span class="sourceLineNo">031</span> *  def.addTo(item, property);<a name="line.31"></a>
<span class="sourceLineNo">032</span> *  ...<a name="line.32"></a>
<span class="sourceLineNo">033</span> *  int age = def.read(item);<a name="line.33"></a>
<span class="sourceLineNo">034</span> *  ...<a name="line.34"></a>
<span class="sourceLineNo">035</span> *  Property prop = this.get(container, itemId);<a name="line.35"></a>
<span class="sourceLineNo">036</span> * &lt;/pre&gt;&lt;/blockquote&gt;<a name="line.36"></a>
<span class="sourceLineNo">037</span> *<a name="line.37"></a>
<span class="sourceLineNo">038</span> * @param &lt;T&gt; property's value type<a name="line.38"></a>
<span class="sourceLineNo">039</span> */<a name="line.39"></a>
<span class="sourceLineNo">040</span>public class PropertyDef&lt;T&gt; {<a name="line.40"></a>
<span class="sourceLineNo">041</span><a name="line.41"></a>
<span class="sourceLineNo">042</span>    /**<a name="line.42"></a>
<span class="sourceLineNo">043</span>     * Comparator that sorts instances by name.<a name="line.43"></a>
<span class="sourceLineNo">044</span>     */<a name="line.44"></a>
<span class="sourceLineNo">045</span>    public static final Comparator&lt;PropertyDef&lt;?&gt;&gt; SORT_BY_NAME = new Comparator&lt;PropertyDef&lt;?&gt;&gt;() {<a name="line.45"></a>
<span class="sourceLineNo">046</span>        @Override<a name="line.46"></a>
<span class="sourceLineNo">047</span>        public int compare(PropertyDef&lt;?&gt; p1, PropertyDef&lt;?&gt; p2) {<a name="line.47"></a>
<span class="sourceLineNo">048</span>            return p1.getName().compareTo(p2.getName());<a name="line.48"></a>
<span class="sourceLineNo">049</span>        }<a name="line.49"></a>
<span class="sourceLineNo">050</span>    };<a name="line.50"></a>
<span class="sourceLineNo">051</span><a name="line.51"></a>
<span class="sourceLineNo">052</span>    private final String name;<a name="line.52"></a>
<span class="sourceLineNo">053</span>    private final Class&lt;T&gt; type;<a name="line.53"></a>
<span class="sourceLineNo">054</span>    private final T defaultValue;<a name="line.54"></a>
<span class="sourceLineNo">055</span><a name="line.55"></a>
<span class="sourceLineNo">056</span>    /**<a name="line.56"></a>
<span class="sourceLineNo">057</span>     * Convenience contructor.<a name="line.57"></a>
<span class="sourceLineNo">058</span>     *<a name="line.58"></a>
<span class="sourceLineNo">059</span>     * &lt;p&gt;<a name="line.59"></a>
<span class="sourceLineNo">060</span>     * Equivalent to:<a name="line.60"></a>
<span class="sourceLineNo">061</span>     *  &lt;blockquote&gt;&lt;pre&gt;<a name="line.61"></a>
<span class="sourceLineNo">062</span>     *  PropertyDef(name, type, null);<a name="line.62"></a>
<span class="sourceLineNo">063</span>     *  &lt;/pre&gt;&lt;/blockquote&gt;<a name="line.63"></a>
<span class="sourceLineNo">064</span>     * &lt;/p&gt;<a name="line.64"></a>
<span class="sourceLineNo">065</span>     */<a name="line.65"></a>
<span class="sourceLineNo">066</span>    public PropertyDef(String name, Class&lt;T&gt; type) {<a name="line.66"></a>
<span class="sourceLineNo">067</span>        this(name, type, null);<a name="line.67"></a>
<span class="sourceLineNo">068</span>    }<a name="line.68"></a>
<span class="sourceLineNo">069</span><a name="line.69"></a>
<span class="sourceLineNo">070</span>    /**<a name="line.70"></a>
<span class="sourceLineNo">071</span>     * Primary constructor.<a name="line.71"></a>
<span class="sourceLineNo">072</span>     *<a name="line.72"></a>
<span class="sourceLineNo">073</span>     * @param name property name; also serves as the property ID<a name="line.73"></a>
<span class="sourceLineNo">074</span>     * @param type property type<a name="line.74"></a>
<span class="sourceLineNo">075</span>     * @param defaultValue default value for the property; may be null<a name="line.75"></a>
<span class="sourceLineNo">076</span>     */<a name="line.76"></a>
<span class="sourceLineNo">077</span>    public PropertyDef(String name, Class&lt;T&gt; type, T defaultValue) {<a name="line.77"></a>
<span class="sourceLineNo">078</span>        if (name == null)<a name="line.78"></a>
<span class="sourceLineNo">079</span>            throw new IllegalArgumentException("null name");<a name="line.79"></a>
<span class="sourceLineNo">080</span>        if (type == null)<a name="line.80"></a>
<span class="sourceLineNo">081</span>            throw new IllegalArgumentException("null type");<a name="line.81"></a>
<span class="sourceLineNo">082</span>        this.name = name;<a name="line.82"></a>
<span class="sourceLineNo">083</span>        this.type = type;<a name="line.83"></a>
<span class="sourceLineNo">084</span>        this.defaultValue = defaultValue;<a name="line.84"></a>
<span class="sourceLineNo">085</span>    }<a name="line.85"></a>
<span class="sourceLineNo">086</span><a name="line.86"></a>
<span class="sourceLineNo">087</span>    /**<a name="line.87"></a>
<span class="sourceLineNo">088</span>     * Get the name of this property. This is also used as the property ID.<a name="line.88"></a>
<span class="sourceLineNo">089</span>     *<a name="line.89"></a>
<span class="sourceLineNo">090</span>     * @return property name, never null<a name="line.90"></a>
<span class="sourceLineNo">091</span>     */<a name="line.91"></a>
<span class="sourceLineNo">092</span>    public String getName() {<a name="line.92"></a>
<span class="sourceLineNo">093</span>        return this.name;<a name="line.93"></a>
<span class="sourceLineNo">094</span>    }<a name="line.94"></a>
<span class="sourceLineNo">095</span><a name="line.95"></a>
<span class="sourceLineNo">096</span>    /**<a name="line.96"></a>
<span class="sourceLineNo">097</span>     * Get the ID of this property. Returns the same thing as {@link #getName()}.<a name="line.97"></a>
<span class="sourceLineNo">098</span>     *<a name="line.98"></a>
<span class="sourceLineNo">099</span>     * @return property name, never null<a name="line.99"></a>
<span class="sourceLineNo">100</span>     */<a name="line.100"></a>
<span class="sourceLineNo">101</span>    public String getPropertyId() {<a name="line.101"></a>
<span class="sourceLineNo">102</span>        return this.getName();<a name="line.102"></a>
<span class="sourceLineNo">103</span>    }<a name="line.103"></a>
<span class="sourceLineNo">104</span><a name="line.104"></a>
<span class="sourceLineNo">105</span>    /**<a name="line.105"></a>
<span class="sourceLineNo">106</span>     * Get the type of the property value that this instance represents.<a name="line.106"></a>
<span class="sourceLineNo">107</span>     *<a name="line.107"></a>
<span class="sourceLineNo">108</span>     * @return property type, never null<a name="line.108"></a>
<span class="sourceLineNo">109</span>     */<a name="line.109"></a>
<span class="sourceLineNo">110</span>    public Class&lt;T&gt; getType() {<a name="line.110"></a>
<span class="sourceLineNo">111</span>        return this.type;<a name="line.111"></a>
<span class="sourceLineNo">112</span>    }<a name="line.112"></a>
<span class="sourceLineNo">113</span><a name="line.113"></a>
<span class="sourceLineNo">114</span>    /**<a name="line.114"></a>
<span class="sourceLineNo">115</span>     * Get the default value for this property.<a name="line.115"></a>
<span class="sourceLineNo">116</span>     *<a name="line.116"></a>
<span class="sourceLineNo">117</span>     * @return property default value<a name="line.117"></a>
<span class="sourceLineNo">118</span>     */<a name="line.118"></a>
<span class="sourceLineNo">119</span>    public T getDefaultValue() {<a name="line.119"></a>
<span class="sourceLineNo">120</span>        return this.defaultValue;<a name="line.120"></a>
<span class="sourceLineNo">121</span>    }<a name="line.121"></a>
<span class="sourceLineNo">122</span><a name="line.122"></a>
<span class="sourceLineNo">123</span>    /**<a name="line.123"></a>
<span class="sourceLineNo">124</span>     * Create a simple {@link ObjectProperty} using the given value.<a name="line.124"></a>
<span class="sourceLineNo">125</span>     *<a name="line.125"></a>
<span class="sourceLineNo">126</span>     * @param value property value<a name="line.126"></a>
<span class="sourceLineNo">127</span>     * @param readOnly whether property should be read-only<a name="line.127"></a>
<span class="sourceLineNo">128</span>     * @return new property<a name="line.128"></a>
<span class="sourceLineNo">129</span>     */<a name="line.129"></a>
<span class="sourceLineNo">130</span>    public ObjectProperty&lt;T&gt; createProperty(T value, boolean readOnly) {<a name="line.130"></a>
<span class="sourceLineNo">131</span>        return new ObjectProperty&lt;T&gt;(value, this.getType(), readOnly);<a name="line.131"></a>
<span class="sourceLineNo">132</span>    }<a name="line.132"></a>
<span class="sourceLineNo">133</span><a name="line.133"></a>
<span class="sourceLineNo">134</span>    /**<a name="line.134"></a>
<span class="sourceLineNo">135</span>     * Create a read/write {@link ObjectProperty} using the given value.<a name="line.135"></a>
<span class="sourceLineNo">136</span>     *<a name="line.136"></a>
<span class="sourceLineNo">137</span>     * &lt;p&gt;<a name="line.137"></a>
<span class="sourceLineNo">138</span>     * Equivalent to:<a name="line.138"></a>
<span class="sourceLineNo">139</span>     *  &lt;blockquote&gt;&lt;pre&gt;<a name="line.139"></a>
<span class="sourceLineNo">140</span>     *  {@link #createProperty(Object, boolean) createProperty()}(value, false);<a name="line.140"></a>
<span class="sourceLineNo">141</span>     *  &lt;/pre&gt;&lt;/blockquote&gt;<a name="line.141"></a>
<span class="sourceLineNo">142</span>     * &lt;/p&gt;<a name="line.142"></a>
<span class="sourceLineNo">143</span>     *<a name="line.143"></a>
<span class="sourceLineNo">144</span>     * @param value property value<a name="line.144"></a>
<span class="sourceLineNo">145</span>     * @return new property<a name="line.145"></a>
<span class="sourceLineNo">146</span>     */<a name="line.146"></a>
<span class="sourceLineNo">147</span>    public ObjectProperty&lt;T&gt; createProperty(T value) {<a name="line.147"></a>
<span class="sourceLineNo">148</span>        return this.createProperty(value, false);<a name="line.148"></a>
<span class="sourceLineNo">149</span>    }<a name="line.149"></a>
<span class="sourceLineNo">150</span><a name="line.150"></a>
<span class="sourceLineNo">151</span>    /**<a name="line.151"></a>
<span class="sourceLineNo">152</span>     * Create a read/write {@link ObjectProperty} using the default value.<a name="line.152"></a>
<span class="sourceLineNo">153</span>     *<a name="line.153"></a>
<span class="sourceLineNo">154</span>     * &lt;p&gt;<a name="line.154"></a>
<span class="sourceLineNo">155</span>     * Equivalent to:<a name="line.155"></a>
<span class="sourceLineNo">156</span>     *  &lt;blockquote&gt;&lt;pre&gt;<a name="line.156"></a>
<span class="sourceLineNo">157</span>     *  {@link #createProperty(Object) createProperty()}(def.getDefaultValue());<a name="line.157"></a>
<span class="sourceLineNo">158</span>     *  &lt;/pre&gt;&lt;/blockquote&gt;<a name="line.158"></a>
<span class="sourceLineNo">159</span>     * &lt;/p&gt;<a name="line.159"></a>
<span class="sourceLineNo">160</span>     *<a name="line.160"></a>
<span class="sourceLineNo">161</span>     * @return new property<a name="line.161"></a>
<span class="sourceLineNo">162</span>     */<a name="line.162"></a>
<span class="sourceLineNo">163</span>    public ObjectProperty&lt;T&gt; createProperty() {<a name="line.163"></a>
<span class="sourceLineNo">164</span>        return this.createProperty(this.getDefaultValue());<a name="line.164"></a>
<span class="sourceLineNo">165</span>    }<a name="line.165"></a>
<span class="sourceLineNo">166</span><a name="line.166"></a>
<span class="sourceLineNo">167</span>    /**<a name="line.167"></a>
<span class="sourceLineNo">168</span>     * Get the property that this instance represents from the given {@link Item}.<a name="line.168"></a>
<span class="sourceLineNo">169</span>     *<a name="line.169"></a>
<span class="sourceLineNo">170</span>     * @return property, or null if not found<a name="line.170"></a>
<span class="sourceLineNo">171</span>     * @throws ClassCastException if the property found has a different type than this instance<a name="line.171"></a>
<span class="sourceLineNo">172</span>     */<a name="line.172"></a>
<span class="sourceLineNo">173</span>    public Property&lt;T&gt; get(Item item) {<a name="line.173"></a>
<span class="sourceLineNo">174</span>        return this.cast(item.getItemProperty(this.getPropertyId()));<a name="line.174"></a>
<span class="sourceLineNo">175</span>    }<a name="line.175"></a>
<span class="sourceLineNo">176</span><a name="line.176"></a>
<span class="sourceLineNo">177</span>    /**<a name="line.177"></a>
<span class="sourceLineNo">178</span>     * Get the property that this instance represents from the given {@link Container}.<a name="line.178"></a>
<span class="sourceLineNo">179</span>     *<a name="line.179"></a>
<span class="sourceLineNo">180</span>     * @param container the container containing the items<a name="line.180"></a>
<span class="sourceLineNo">181</span>     * @param itemId the ID of the item containing the property<a name="line.181"></a>
<span class="sourceLineNo">182</span>     * @return property, or null if not found<a name="line.182"></a>
<span class="sourceLineNo">183</span>     * @throws ClassCastException if the property found has a different type than this instance<a name="line.183"></a>
<span class="sourceLineNo">184</span>     */<a name="line.184"></a>
<span class="sourceLineNo">185</span>    public Property&lt;T&gt; get(Container container, Object itemId) {<a name="line.185"></a>
<span class="sourceLineNo">186</span>        return this.cast(container.getContainerProperty(itemId, this.getPropertyId()));<a name="line.186"></a>
<span class="sourceLineNo">187</span>    }<a name="line.187"></a>
<span class="sourceLineNo">188</span><a name="line.188"></a>
<span class="sourceLineNo">189</span>    /**<a name="line.189"></a>
<span class="sourceLineNo">190</span>     * Verify that the given property has the same Java type as this property definition.<a name="line.190"></a>
<span class="sourceLineNo">191</span>     *<a name="line.191"></a>
<span class="sourceLineNo">192</span>     * &lt;p&gt;<a name="line.192"></a>
<span class="sourceLineNo">193</span>     * This essentially verifies that &lt;code&gt;property.getType() == this.getType()&lt;/code&gt;.<a name="line.193"></a>
<span class="sourceLineNo">194</span>     *<a name="line.194"></a>
<span class="sourceLineNo">195</span>     * @param property the property to verify; may be null<a name="line.195"></a>
<span class="sourceLineNo">196</span>     * @return null if {@code property} is null, otherwise {@code property}<a name="line.196"></a>
<span class="sourceLineNo">197</span>     * @throws ClassCastException if {@code property} has a different type than this definition<a name="line.197"></a>
<span class="sourceLineNo">198</span>     */<a name="line.198"></a>
<span class="sourceLineNo">199</span>    @SuppressWarnings("unchecked")<a name="line.199"></a>
<span class="sourceLineNo">200</span>    public Property&lt;T&gt; cast(Property&lt;?&gt; property) {<a name="line.200"></a>
<span class="sourceLineNo">201</span>        if (property == null)<a name="line.201"></a>
<span class="sourceLineNo">202</span>            return null;<a name="line.202"></a>
<span class="sourceLineNo">203</span>        if (property.getType() != this.getType()) {<a name="line.203"></a>
<span class="sourceLineNo">204</span>            throw new ClassCastException("property type " + property.getType().getName()<a name="line.204"></a>
<span class="sourceLineNo">205</span>              + " != definition type " + this.getType().getName());<a name="line.205"></a>
<span class="sourceLineNo">206</span>        }<a name="line.206"></a>
<span class="sourceLineNo">207</span>        return (Property&lt;T&gt;)property;<a name="line.207"></a>
<span class="sourceLineNo">208</span>    }<a name="line.208"></a>
<span class="sourceLineNo">209</span><a name="line.209"></a>
<span class="sourceLineNo">210</span>    /**<a name="line.210"></a>
<span class="sourceLineNo">211</span>     * Add a property represented by this instance to the given {@link Container}.<a name="line.211"></a>
<span class="sourceLineNo">212</span>     *<a name="line.212"></a>
<span class="sourceLineNo">213</span>     * @param container the container to add the property to<a name="line.213"></a>
<span class="sourceLineNo">214</span>     * @return true if the operation succeeded, false if not<a name="line.214"></a>
<span class="sourceLineNo">215</span>     * @throws UnsupportedOperationException if the operation is not supported<a name="line.215"></a>
<span class="sourceLineNo">216</span>     */<a name="line.216"></a>
<span class="sourceLineNo">217</span>    public boolean addTo(Container container) {<a name="line.217"></a>
<span class="sourceLineNo">218</span>        return container.addContainerProperty(this.getPropertyId(), this.getType(), this.getDefaultValue());<a name="line.218"></a>
<span class="sourceLineNo">219</span>    }<a name="line.219"></a>
<span class="sourceLineNo">220</span><a name="line.220"></a>
<span class="sourceLineNo">221</span>    /**<a name="line.221"></a>
<span class="sourceLineNo">222</span>     * Add a property represented by this instance to the given {@link Item}.<a name="line.222"></a>
<span class="sourceLineNo">223</span>     *<a name="line.223"></a>
<span class="sourceLineNo">224</span>     * @param item the item to add the property to<a name="line.224"></a>
<span class="sourceLineNo">225</span>     * @param property the property to be added to the item and identified by this instance's name<a name="line.225"></a>
<span class="sourceLineNo">226</span>     * @return true if the operation succeeded, false if not<a name="line.226"></a>
<span class="sourceLineNo">227</span>     * @throws UnsupportedOperationException if the operation is not supported<a name="line.227"></a>
<span class="sourceLineNo">228</span>     */<a name="line.228"></a>
<span class="sourceLineNo">229</span>    public boolean addTo(Item item, Property&lt;T&gt; property) {<a name="line.229"></a>
<span class="sourceLineNo">230</span>        return item.addItemProperty(this.getPropertyId(), property);<a name="line.230"></a>
<span class="sourceLineNo">231</span>    }<a name="line.231"></a>
<span class="sourceLineNo">232</span><a name="line.232"></a>
<span class="sourceLineNo">233</span>    /**<a name="line.233"></a>
<span class="sourceLineNo">234</span>     * Add a property represented by this instance to the given {@link Table}.<a name="line.234"></a>
<span class="sourceLineNo">235</span>     *<a name="line.235"></a>
<span class="sourceLineNo">236</span>     * @param table the table to add the property to<a name="line.236"></a>
<span class="sourceLineNo">237</span>     * @return true if the operation succeeded, false if not<a name="line.237"></a>
<span class="sourceLineNo">238</span>     * @throws UnsupportedOperationException if the operation is not supported<a name="line.238"></a>
<span class="sourceLineNo">239</span>     */<a name="line.239"></a>
<span class="sourceLineNo">240</span>    public boolean addTo(Table table) {<a name="line.240"></a>
<span class="sourceLineNo">241</span>        return table.addContainerProperty(this.getPropertyId(), this.getType(), this.getDefaultValue());<a name="line.241"></a>
<span class="sourceLineNo">242</span>    }<a name="line.242"></a>
<span class="sourceLineNo">243</span><a name="line.243"></a>
<span class="sourceLineNo">244</span>    /**<a name="line.244"></a>
<span class="sourceLineNo">245</span>     * Read the property that this instance represents from the given {@link Item}.<a name="line.245"></a>
<span class="sourceLineNo">246</span>     *<a name="line.246"></a>
<span class="sourceLineNo">247</span>     * @return property value, or null if not found<a name="line.247"></a>
<span class="sourceLineNo">248</span>     * @throws ClassCastException if the property in {@code item} has the wrong type<a name="line.248"></a>
<span class="sourceLineNo">249</span>     */<a name="line.249"></a>
<span class="sourceLineNo">250</span>    public T read(Item item) {<a name="line.250"></a>
<span class="sourceLineNo">251</span>        Property&lt;T&gt; property = this.get(item);<a name="line.251"></a>
<span class="sourceLineNo">252</span>        if (property == null)<a name="line.252"></a>
<span class="sourceLineNo">253</span>            return null;<a name="line.253"></a>
<span class="sourceLineNo">254</span>        return this.type.cast(property.getValue());<a name="line.254"></a>
<span class="sourceLineNo">255</span>    }<a name="line.255"></a>
<span class="sourceLineNo">256</span><a name="line.256"></a>
<span class="sourceLineNo">257</span>    /**<a name="line.257"></a>
<span class="sourceLineNo">258</span>     * Determine whether this instance supports sorting property values.<a name="line.258"></a>
<span class="sourceLineNo">259</span>     *<a name="line.259"></a>
<span class="sourceLineNo">260</span>     * &lt;p&gt;<a name="line.260"></a>
<span class="sourceLineNo">261</span>     * The implementation in {@link PropertyDef} returns true if this instance's type implements {@link Comparable}.<a name="line.261"></a>
<span class="sourceLineNo">262</span>     *<a name="line.262"></a>
<span class="sourceLineNo">263</span>     * @see #sort sort()<a name="line.263"></a>
<span class="sourceLineNo">264</span>     */<a name="line.264"></a>
<span class="sourceLineNo">265</span>    public boolean isSortable() {<a name="line.265"></a>
<span class="sourceLineNo">266</span>        return Comparable.class.isAssignableFrom(this.type);<a name="line.266"></a>
<span class="sourceLineNo">267</span>    }<a name="line.267"></a>
<span class="sourceLineNo">268</span><a name="line.268"></a>
<span class="sourceLineNo">269</span>    /**<a name="line.269"></a>
<span class="sourceLineNo">270</span>     * Sort two values of this property. Optional operation.<a name="line.270"></a>
<span class="sourceLineNo">271</span>     *<a name="line.271"></a>
<span class="sourceLineNo">272</span>     * &lt;p&gt;<a name="line.272"></a>
<span class="sourceLineNo">273</span>     * The implementation in {@link PropertyDef} sorts null values first, then delegates to {@link Comparable}<a name="line.273"></a>
<span class="sourceLineNo">274</span>     * if the values implement it, or else throws {@link UnsupportedOperationException}.<a name="line.274"></a>
<span class="sourceLineNo">275</span>     *<a name="line.275"></a>
<span class="sourceLineNo">276</span>     * @param value1 first value, possibly null<a name="line.276"></a>
<span class="sourceLineNo">277</span>     * @param value2 second value, possibly null<a name="line.277"></a>
<span class="sourceLineNo">278</span>     * @return negative, zero, or positive based on comparing {@code value1} to {@code value2}<a name="line.278"></a>
<span class="sourceLineNo">279</span>     * @throws UnsupportedOperationException if this instance does not support sorting property values<a name="line.279"></a>
<span class="sourceLineNo">280</span>     */<a name="line.280"></a>
<span class="sourceLineNo">281</span>    @SuppressWarnings("unchecked")<a name="line.281"></a>
<span class="sourceLineNo">282</span>    public int sort(T value1, T value2) {<a name="line.282"></a>
<span class="sourceLineNo">283</span>        if ((value1 == null) != (value2 == null))<a name="line.283"></a>
<span class="sourceLineNo">284</span>            return value1 == null ? -1 : 1;<a name="line.284"></a>
<span class="sourceLineNo">285</span>        if (value1 == null &amp;&amp; value2 == null)<a name="line.285"></a>
<span class="sourceLineNo">286</span>            return 0;<a name="line.286"></a>
<span class="sourceLineNo">287</span>        try {<a name="line.287"></a>
<span class="sourceLineNo">288</span>            return ((Comparable&lt;T&gt;)value1).compareTo(value2);<a name="line.288"></a>
<span class="sourceLineNo">289</span>        } catch (ClassCastException e) {<a name="line.289"></a>
<span class="sourceLineNo">290</span>            throw new UnsupportedOperationException(e);<a name="line.290"></a>
<span class="sourceLineNo">291</span>        }<a name="line.291"></a>
<span class="sourceLineNo">292</span>    }<a name="line.292"></a>
<span class="sourceLineNo">293</span><a name="line.293"></a>
<span class="sourceLineNo">294</span>    @Override<a name="line.294"></a>
<span class="sourceLineNo">295</span>    public int hashCode() {<a name="line.295"></a>
<span class="sourceLineNo">296</span>        return this.name.hashCode()<a name="line.296"></a>
<span class="sourceLineNo">297</span>          ^ this.type.hashCode()<a name="line.297"></a>
<span class="sourceLineNo">298</span>          ^ (this.defaultValue != null ? this.defaultValue.hashCode() : 0);<a name="line.298"></a>
<span class="sourceLineNo">299</span>    }<a name="line.299"></a>
<span class="sourceLineNo">300</span><a name="line.300"></a>
<span class="sourceLineNo">301</span>    @Override<a name="line.301"></a>
<span class="sourceLineNo">302</span>    public boolean equals(Object obj) {<a name="line.302"></a>
<span class="sourceLineNo">303</span>        if (obj == null || obj.getClass() != this.getClass())<a name="line.303"></a>
<span class="sourceLineNo">304</span>            return false;<a name="line.304"></a>
<span class="sourceLineNo">305</span>        final PropertyDef&lt;?&gt; that = (PropertyDef&lt;?&gt;)obj;<a name="line.305"></a>
<span class="sourceLineNo">306</span>        return this.name.equals(that.name)<a name="line.306"></a>
<span class="sourceLineNo">307</span>          &amp;&amp; this.type == that.type<a name="line.307"></a>
<span class="sourceLineNo">308</span>          &amp;&amp; (this.defaultValue != null ? this.defaultValue.equals(that.defaultValue) : that.defaultValue == null);<a name="line.308"></a>
<span class="sourceLineNo">309</span>    }<a name="line.309"></a>
<span class="sourceLineNo">310</span><a name="line.310"></a>
<span class="sourceLineNo">311</span>    @Override<a name="line.311"></a>
<span class="sourceLineNo">312</span>    public String toString() {<a name="line.312"></a>
<span class="sourceLineNo">313</span>        return this.getClass().getSimpleName() + "[name=\"" + this.name + "\",type="<a name="line.313"></a>
<span class="sourceLineNo">314</span>          + this.type.getName() + ",defaultValue=" + this.defaultValue + "]";<a name="line.314"></a>
<span class="sourceLineNo">315</span>    }<a name="line.315"></a>
<span class="sourceLineNo">316</span>}<a name="line.316"></a>
<span class="sourceLineNo">317</span><a name="line.317"></a>




























































</pre>
</div>
</body>
</html>
